<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>DRAFT utility to use formulas provided as text, to calculate indicators — calc_ejam • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="DRAFT utility to use formulas provided as text, to calculate indicators — calc_ejam"><meta name="description" content="DRAFT utility to use formulas provided as text, to calculate indicators"><meta property="og:description" content="DRAFT utility to use formulas provided as text, to calculate indicators"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>DRAFT utility to use formulas provided as text, to calculate indicators</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/utils_calc_ejam.R" class="external-link"><code>R/utils_calc_ejam.R</code></a></small>
      <div class="d-none name"><code>calc_ejam.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>DRAFT utility to use formulas provided as text, to calculate indicators</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">calc_ejam</span><span class="op">(</span><span class="va">bg</span>, keep.old <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"bgid"</span>, <span class="st">"pop"</span><span class="op">)</span>, keep.new <span class="op">=</span> <span class="st">"all"</span>, <span class="va">formulas</span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-bg">bg<a class="anchor" aria-label="anchor" href="#arg-bg"></a></dt>
<dd><p>data.frame//table of indicators or variables to use</p></dd>


<dt id="arg-keep-old">keep.old<a class="anchor" aria-label="anchor" href="#arg-keep-old"></a></dt>
<dd><p>names of columns (variables) to retain from among those provided in bg</p></dd>


<dt id="arg-keep-new">keep.new<a class="anchor" aria-label="anchor" href="#arg-keep-new"></a></dt>
<dd><p>names of calculated variables to retain in output</p></dd>


<dt id="arg-formulas">formulas<a class="anchor" aria-label="anchor" href="#arg-formulas"></a></dt>
<dd><p>text strings of formulas</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>data.frame of calculated variables one row per bg row</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>may be used by doaggregate_custom()</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span></span>
<span><span class="co">### example using just 10 block groups from 1 county in Delaware</span></span>
<span></span>
<span> <span class="va">c1</span> <span class="op">&lt;-</span> <span class="fu"><a href="fips2countyname.html">fips2countyname</a></span><span class="op">(</span><span class="fu"><a href="fips_counties_from_state_abbrev.html">fips_counties_from_state_abbrev</a></span><span class="op">(</span><span class="st">'DE'</span><span class="op">)</span>, includestate <span class="op">=</span> <span class="cn">F</span><span class="op">)</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span></span>
<span> <span class="va">bgdf</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span><span class="fu">EJAM</span><span class="fu">::</span><span class="va"><a href="blockgroupstats.html">blockgroupstats</a></span><span class="op">[</span><span class="va">ST</span> <span class="op">==</span> <span class="st">"DE"</span> <span class="op">&amp;</span> <span class="va">countyname</span> <span class="op">==</span> <span class="va">c1</span>, <span class="op">]</span><span class="op">)</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span>, <span class="op">]</span></span>
<span></span>
<span> <span class="va">newdf</span> <span class="op">&lt;-</span> <span class="fu">calc_ejam</span><span class="op">(</span><span class="va">bgdf</span>, keep.old <span class="op">=</span> <span class="st">""</span>,</span>
<span>   formulas <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span>
<span>     <span class="st">"my_custom_recalc_demog &lt;- (pctlowinc + pctmin)/2"</span>,</span>
<span>     <span class="st">"mystat2  = 100 * pctlowinc"</span><span class="op">)</span><span class="op">)</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">cbind</a></span><span class="op">(</span>Demog.Index <span class="op">=</span> <span class="va">bgdf</span><span class="op">$</span><span class="va">Demog.Index</span>, <span class="va">newdf</span>, pctlowinc <span class="op">=</span> <span class="va">bgdf</span><span class="op">$</span><span class="va">pctlowinc</span><span class="op">)</span></span>
<span></span>
<span><span class="va">newdf</span> <span class="op">&lt;-</span> <span class="fu">calc_ejam</span><span class="op">(</span><span class="va">bgdf</span>, formulas <span class="op">=</span> <span class="va">formulas_d</span><span class="op">)</span></span>
<span><span class="va">newdf</span></span>
<span></span>
<span></span>
<span><span class="co">##  example of entire US</span></span>
<span><span class="co">#</span></span>
<span><span class="va">newdf1</span>  <span class="op">&lt;-</span> <span class="fu">calc_ejam</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/as.data.frame.html" class="external-link">as.data.frame</a></span><span class="op">(</span><span class="va">bgdf</span><span class="op">)</span>, formulas <span class="op">=</span> <span class="va">formulas_d</span><span class="op">)</span></span>
<span>  <span class="fu"><a href="https://rdrr.io/r/base/t.html" class="external-link">t</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/summary.html" class="external-link">summary</a></span><span class="op">(</span><span class="va">newdf1</span><span class="op">)</span><span class="op">)</span></span>
<span></span>
<span><span class="va">bgdf</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span><span class="va">blockgroupstats</span><span class="op">)</span></span>
<span><span class="va">newdf</span> <span class="op">&lt;-</span> <span class="fu">calc_ejam</span><span class="op">(</span><span class="va">bgdf</span>,</span>
<span>                   keep.old <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'bgid'</span>, <span class="st">'pop'</span>, <span class="st">'hisp'</span><span class="op">)</span>,</span>
<span>                   keep.new <span class="op">=</span> <span class="st">"all"</span>,</span>
<span>                   formulas <span class="op">=</span> <span class="va">formulas_d</span></span>
<span><span class="op">)</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/t.html" class="external-link">t</a></span><span class="op">(</span><span class="va">newdf</span><span class="op">[</span><span class="fl">1001</span><span class="op">:</span><span class="fl">1002</span>, <span class="op">]</span><span class="op">)</span>, <span class="fl">3</span><span class="op">)</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">cbind</a></span><span class="op">(</span></span>
<span>  <span class="va">newdf</span><span class="op">[</span><span class="fl">1001</span><span class="op">:</span><span class="fl">1031</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'hisp'</span>, <span class="st">'pop'</span>, <span class="st">'pcthisp'</span><span class="op">)</span><span class="op">]</span>,</span>
<span>  check <span class="op">=</span> <span class="op">(</span><span class="va">newdf</span><span class="op">$</span><span class="va">hisp</span><span class="op">[</span><span class="fl">1001</span><span class="op">:</span><span class="fl">1031</span><span class="op">]</span> <span class="op">/</span> <span class="va">newdf</span><span class="op">$</span><span class="va">pop</span><span class="op">[</span><span class="fl">1001</span><span class="op">:</span><span class="fl">1031</span><span class="op">]</span><span class="op">)</span></span>
<span>  <span class="op">)</span></span>
<span><span class="co">## note the 0-100 percentages in blockgroupstats versus the 0-1 calculated percentages</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">cbind</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/lapply.html" class="external-link">sapply</a></span><span class="op">(</span><span class="va">newdf</span>, <span class="va">max</span>, na.rm<span class="op">=</span><span class="cn">T</span><span class="op">)</span>,<span class="fl">2</span><span class="op">)</span>,</span>
<span><span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">newdf</span><span class="op">)</span> <span class="op"><a href="https://rdrr.io/r/base/match.html" class="external-link">%in%</a></span> <span class="va">names_pct_as_fraction_blockgroupstats</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">EJAM</span><span class="fu">:::</span><span class="fu"><a href="formula_varname.html">formula_varname</a></span><span class="op">(</span><span class="va">formulas_d</span><span class="op">)</span></span>
<span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/rm.html" class="external-link">rm</a></span><span class="op">(</span><span class="va">bgdf</span><span class="op">)</span></span>
<span></span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

